Skip to main content

FlowProfession Methods

An object defining methods for the FlowProfession class.

SetFromVariable(sourceVariable)

Sets the current profession using data from a Variable object.

Parameters:

sourceVariable (required): Variable
The Variable object containing the profession data.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


SetFromPosition(sourcePosition)

Sets the current profession based on a FlowPosition instance.

Parameters:

sourcePosition (required): FlowPosition
The FlowPosition instance to use for setting the profession.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


SetConstantProfession(id, code, description)

Assigns a constant profession using its ID, code, and description.

Parameters:

id (required): long
The unique identifier of the profession.

code (required): string
The code of the profession.

description (required): string
The description of the profession.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


Initialize()

Initializes the profession step with default settings.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


SetConstantProfession(id)

Assigns a constant profession to the workflow step using a profession ID.

Parameters:

id (required): long
The unique identifier of the profession.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


SetFromFlowInitiator()

Sets the profession based on the flow initiator.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


SetConstantProfession(profession)

Assigns a constant profession to the workflow step using a profession object.

Parameters:

profession (required): Profession
The profession object containing details to assign.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


SetFromOther(sourceProfession)

Sets the current profession based on another FlowProfession instance.

Parameters:

sourceProfession (required): FlowProfession
The FlowProfession instance to copy details from.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


ToLiquid()

Converts the profession data into a format compatible with Liquid templates.

Returns:

Type: object
Returns the profession data as an object.

This is a sync method. Method runs synchronously.